Skip to content

CJM-97211 Introduce xdm-schema for message-rendering-context dataset #1977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Jul 30, 2025

Conversation

himanshi2010
Copy link
Contributor

@himanshi2010 himanshi2010 commented May 20, 2025

Introduced new field group schemas for Message Rendered Content, Rendering Metadata and Delivery Metadata of the communications going out of the AJO to provide the message-export functionality to the customers.

Wiki: https://wiki.corp.adobe.com/display/CJM/Message+Export+in+AJO

@anandphatak anandphatak self-assigned this May 30, 2025
Copy link
Collaborator

@anandphatak anandphatak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please run the following commands on your local clone before creating the pull request:
npm install
npm run lint
npm test
Fix any issues then create the pull request.

"type": "object",
"title": "Message Details",
"description": "Contains the specific content details for the message, varying by channel (e.g., email or SMS).",
"oneOf": [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if oneOf will work. What are you expecting the validator to validate?

"title": "Message Details",
"description": "Contains the specific content details for the message, varying by channel (e.g., email or SMS).",
"oneOf": [
{
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The structure of this JSON schema does not look right.

@himanshi2010 himanshi2010 marked this pull request as draft June 9, 2025 11:28
@himanshi2010 himanshi2010 marked this pull request as ready for review July 2, 2025 09:59
@himanshi2010
Copy link
Contributor Author

@anandphatak Would you please take a look at this PR?

@anandphatak
Copy link
Collaborator

@himanshi2010 there are still some issues with the PR. My comments above for "allOf" are not addressed. Please setup a meeting to discuss.

@himanshi2010 himanshi2010 requested a review from anandphatak July 16, 2025 18:27
"title": "Email Metadata",
"description": "Metadata specific to email delivery",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change the field name from https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient to xdm:recipient.

(Essentially, remove the namespace https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata from all child fields nested under parent field https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata defined at line #19. Do this to the rest of the fields.

"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient": {
"type": "object",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/email": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As note above please change the field name from https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/email to xdm:email.

"format": "email",
"description": "Recipient's email address"
},
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/name": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change from https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/name to xdm:name. And so on...

}
},
"required": [
"https://ns.adobe.com/experience/customerJourneyManagement/messageDeliveryMetadata/emailMetadata/recipient/email"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xdm:email

"$ref": "#/definitions/messageDeliveryMetadata"
}
],
"meta:status": "stable"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will recommend it to keep "meta:status": "experimental" until this field group is tested and stabilized. Keeping it "experimental" marks it as beta, and is only available to limited number of IMS Orgs.

"title": "Email Channel Content",
"description": "Email-specific rendered content",
"properties": {
"https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent/subject": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as before for using field names without namespace https://ns.adobe.com/experience/customerJourneyManagement/messageRenderedContent/emailContent

"$ref": "#/definitions/messageRenderedContent"
}
],
"meta:status": "stable"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend "experimental"

"$ref": "#/definitions/messageRenderingMetadata"
}
],
"meta:status": "stable"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

experimental

@anandphatak anandphatak merged commit d03f3c8 into adobe:master Jul 30, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants